home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 March / CMCD0305.ISO / Software / Demo / Itcomm / auscomp-itcommander-win5.exe / {pf} / Firebird / firebird.conf < prev    next >
Text File  |  2004-02-20  |  18KB  |  598 lines
  1. #######################################
  2. #
  3. # Firebird configuration file
  4. #
  5. # Comments
  6. # --------
  7. # The # character is used for comments and can be placed anywhere on a
  8. # line.  Anything following the # character on a line is considered a
  9. # comment.
  10. #
  11. # Examples:
  12. #
  13. #    # This is a comment
  14. #    DefaultDbCachePages = 2048   # This is an end-of-line comment
  15. #
  16. # Entries
  17. # -------
  18. # The default value for each entry is listed to the right of the "=".
  19. # To activate an entry, remove the leading "#"s and supply the desired
  20. # value.
  21. #
  22. # Please note, a number of the values are specified in **Bytes** (Not KB).
  23. # Accordingly, we have provided some simple conversion tables at the bottom
  24. # of this file.
  25. #
  26. # There are three types of configuration values: integer, boolean and string.
  27. # 
  28. # Integer
  29. # --------
  30. # Integers is what they sound like, an integral value. Examples:
  31. #   1
  32. #   42
  33. #   4711
  34. # 
  35. # Boolean
  36. # -------
  37. # Boolean is expressed as integer values with 0 (zero) being "false" and
  38. # non-zero is taken to mean "true". For consistency we recommend you
  39. # only use 0/1.
  40. # 
  41. # String
  42. # ------
  43. # Strings are also what they sound like, strings. Examples:
  44. #   RootDirectory  = /opt/firebird
  45. #   RemotePipeName = pipe47
  46. #
  47. #
  48. # Portions of this file have been reproduced/made available with the
  49. # permission of Ann Harrison @ IBPhoenix.
  50. #
  51. #######################################
  52.  
  53. # ==================================
  54. # Settings for all platforms/engines
  55. # ==================================
  56. #
  57. # ----------------------------
  58. # Specify the root directory under which Firebird is installed.
  59. # Can be used to override the OS-specifically determined one.
  60. #
  61. # Type: string
  62. #
  63. #RootDirectory =
  64.  
  65.  
  66. # ----------------------------
  67. # Database Paths/Directories
  68. #
  69. # DatabaseAccess may be None, Full or Restrict. If you choose Restrict, 
  70. # provide ';'-separated trees list, where database files are stored.
  71. # Relative paths are treated relative to RootDirectory entry
  72. # (see above). Default value 'Full' gives full access to all files
  73. # on your site. To specify access to specific trees, enum all required
  74. # paths (for Win32 this may be something like 'C:\DataBase;D:\Mirror', 
  75. # for unix - '/db;/mnt/mirrordb'). If you choose 'None', then only
  76. # databases listed in aliases.conf can be attached.
  77. #
  78. # UNCONTROLLED DATABASE ACCESS MAY COMPROMISE YOUR SYSTEM!
  79. # IT IS STRONGLY RECOMMENDED THAT THIS SETTING BE USED TO LIMIT
  80. # DATABASE LOCATIONS!
  81. #
  82. # Type: string (special format)
  83. #
  84. #DatabaseAccess = Full
  85.  
  86.  
  87. # ----------------------------
  88. # External File Paths/Directories
  89. #
  90. # ExternalFileAccess may be None, Full or Restrict. If you choose 
  91. # Restrict, provide ';'-separated trees list, where external files 
  92. # are stored. Relative paths are treated relative to RootDirectory entry
  93. # (see above). Default value 'None' disables any use of external files
  94. # on your site. To specify access to specific trees, enum all required
  95. # paths (for Win32 this may be something like 'C:\ExternalTables', 
  96. # for unix - '/db/extern;/mnt/extern').
  97. #
  98. # NOTE: THE EXTERNAL TABLE ENGINE FEATURE COULD BE USED TO COMPROMISE
  99. # THE SERVER/HOST AS WELL AS DATABASE SECURITY!!
  100. #
  101. # IT IS STRONGLY RECOMMENDED THAT THIS SETTING BE USED TO LIMIT
  102. # EXTERNAL TABLE LOCATIONS!
  103. #
  104. # Type: string (special format)
  105. #
  106. #ExternalFileAccess = None
  107.  
  108.  
  109. # ----------------------------
  110. # External Function (UDF) Paths/Directories
  111. #
  112. # UdfAccess may be None, Full or Restrict. If you choose 
  113. # Restrict, provide ';'-separated trees list, where UDF libraries
  114. # are stored. Relative paths are treated relative to RootDirectory entry
  115. # (see above). Default value 'Restrict UDF' provides the same restrictions
  116. # as in FB 1.0. To specify access to specific trees, enum all required
  117. # paths (for Win32 this may be something like 'C:\ExternalFunctions', 
  118. # for unix - '/db/extern;/mnt/extern').
  119. #
  120. # NOTE: THE EXTERNAL FUNCTION ENGINE FEATURE COULD BE USED TO COMPROMISE
  121. # THE SERVER/HOST AS WELL AS DATABASE SECURITY!!
  122. #
  123. # IT IS STRONGLY RECOMMENDED THAT THIS SETTING BE USED TO LIMIT
  124. # EXTERNAL FUNCTION LOCATIONS! SPECIALLY AVOID HAVING 
  125. # COMMON SUBTREES IN UdfAccess & ExternalFileAccess !
  126. #
  127. # Type: string (special format)
  128. #
  129. #UdfAccess = Restrict UDF
  130.  
  131.  
  132. # ----------------------------
  133. # Temporary directories
  134. #
  135. # Provide ';'-separated trees list, where temporary files are stored.
  136. # Relative paths are treated relative to RootDirectory entry
  137. # (see above). Default value is determined using FIREBIRD_TMP,
  138. # TEMP or TMP environment options. Every directory item may have optional
  139. # size argument to limit its storage, this argument follows the directory
  140. # name and must be separated by at least one space character. If the size
  141. # argument is omitted or invalid, then all available space in this
  142. # directory will be used.
  143. #
  144. # E.g.:
  145. # TempDirectories = c:\temp
  146. # or
  147. # TempDirectories = c:\temp;d:\temp
  148. # or
  149. # TempDirectories = c:\temp 100000000;d:\temp 500000000;e:\temp
  150. #
  151. # Type: string (special format)
  152. #
  153. #TempDirectories =
  154.  
  155.  
  156. # ----------------------------
  157. # Number of cached database pages
  158. #
  159. # This sets the number of pages from any one database that can be held
  160. # in cache at once. If you increase this value, the engine will
  161. # allocate more pages to the cache for every database. By default, the
  162. # SuperServer allocates 2048 pages for each database and the classic
  163. # allocates 75 pages per client connection per database.
  164. #
  165. # Type: integer
  166. #
  167. #DefaultDbCachePages = 2048
  168.  
  169.  
  170. # ----------------------------
  171. # In-memory sorting module
  172. #
  173. # The amount of memory allocated for each sort block.
  174. #
  175. # Type: integer
  176. #
  177. #SortMemBlockSize = 1048576
  178.  
  179. #
  180. # The maximum amount of memory to be allocated by the in-memory
  181. # sorting module.
  182. #
  183. # For Classic servers, this setting is defaulted to 8 MB.
  184. # Although it can be increased, the value applies to each client
  185. # connection/server instance and thus consumes a lot of memory.
  186. #
  187. # Type: integer
  188. #
  189. #SortMemUpperLimit = 67108864
  190.  
  191.  
  192. # ----------------------------
  193. # Backward-compatible parameter ordering as it was in FB v1/IB
  194. #
  195. # Type: boolean
  196. #
  197. #OldParameterOrdering = 0
  198.  
  199.  
  200. # ----------------------------
  201. # Boolean evaluation method (complete or shortcut)
  202. #
  203. # If your SQL code depends on side-effects of full evaluation of OR
  204. # and AND statements (right-hand-side terms), even if the expressions
  205. # final result could be determined by just examining the value of the
  206. # first term, you might need to turn this on.
  207. #
  208. # Type: boolean
  209. #
  210. #CompleteBooleanEvaluation = 0
  211.  
  212.  
  213. # ----------------------------
  214. # 
  215. # Determines the number of seconds that the lock manager will wait after a
  216. # conflict has been encountered before purging locks from dead processes 
  217. # and doing extra deadlock scan cycle. Engine detects deadlocks instantly 
  218. # in all normal cases, so this value affects things only if something goes
  219. # wrong. Setting it too low may degrade system performance. 
  220. #
  221. # Type: integer
  222. #
  223. #DeadlockTimeout = 10
  224.  
  225.  
  226. # ----------------------------
  227. #
  228. # How often the pages are flushed on disk
  229. # (for databases with ForcedWrites=Off only)
  230. #
  231. # Number of unflushed writes which will accumulate before they are
  232. # flushed, at the next transaction commit.  For non-Win32 ports,
  233. # the default value is -1 (Disabled)
  234. #
  235. # Type: integer
  236. #
  237. #MaxUnflushedWrites = 100
  238.  
  239. #
  240. # Number of seconds during which unflushed writes will accumulate
  241. # before they are flushed, at the next transaction commit. For non-Win32
  242. # ports, the default value is -1 (Disabled)
  243. #
  244. # Type: integer
  245. #
  246. #MaxUnflushedWriteTime = 5
  247.  
  248.  
  249. # ----------------------------
  250. # Client Connection Settings (Basic)
  251. #
  252. # Seconds to wait before concluding an attempt to connect has failed.
  253. #
  254. # Type: integer
  255. #
  256. #ConnectionTimeout = 180
  257.  
  258. #
  259. # Seconds to wait on a silent client connection before the server sends
  260. # dummy packets to request acknowledgment.
  261. #
  262. # DO NOT USE THIS OPTION. It may hang or crash Windows on the client side as 
  263. # explained here: http://support.microsoft.com/default.aspx?kbid=296265
  264. # or may not prevent eventual inactive client disconnection for other OS.
  265. #
  266. # Normally, Firebird uses SO_KEEPALIVE socket option to keep track of 
  267. # active connections. If you do not like default 2-hour keepalive timeout
  268. # then adjust your server OS settings appropriately. On UNIX-like OS's, 
  269. # modify contents of /proc/sys/net/ipv4/tcp_keepalive_*. On Windows, 
  270. # follow instrutions of this article:
  271. # http://support.microsoft.com/default.aspx?kbid=140325
  272. #
  273. # Type: integer
  274. #
  275. #DummyPacketInterval = 0
  276.  
  277.  
  278. # ----------------------------
  279. # TCP Protocol Settings
  280. #
  281. # The TCP Service name/Port number to be used for client database
  282. # connections. 
  283. #
  284. # It is only necessary to change one of the entries, not both.  The
  285. # order of precendence is the 'RemoteServiceName' (if an entry is
  286. # found in the 'services.' file) then the 'RemoteServicePort'.
  287. #
  288. # Type: string, integer
  289. #
  290. #RemoteServiceName = gds_db
  291. #RemoteServicePort = 3050
  292.  
  293. #
  294. # The TCP Port Number to be used for server Event Notification
  295. # messages.  The value of 0 (Zero) means that the server will choose
  296. # a port number randomly.
  297. #
  298. # Type: integer
  299. #
  300. #RemoteAuxPort = 0
  301.  
  302. #
  303. # TCP/IP buffer size for send and receive buffers of both the client
  304. # and server. The engine reads ahead of the client and can send 
  305. # several rows of data in a single packet. The larger the packet size,
  306. # the more data is sent per transfer. Range is 1448 to 32768.
  307. #
  308. # Type: integer
  309. #
  310. #TcpRemoteBufferSize = 8192
  311.  
  312. #
  313. # Either enables or disables Nagle algorithm (TCP_NODELAY option of
  314. # socket) of the socket connection.
  315. #
  316. # Note: Currently this is only active for super server, classic
  317. # server needs an extra wrapper program.
  318. #
  319. # Type: boolean
  320. #
  321. #TcpNoNagle = 0
  322.  
  323. #
  324. # Allows incoming connections to be bound to the IP address of a
  325. # specific network card. It enables rejection of incoming connections
  326. # through any other network interface except this one. By default,
  327. # connections from any available network interface are allowed.
  328. #
  329. # Type: string
  330. #
  331. #RemoteBindAddress = 
  332.  
  333.  
  334. # ----------------------------
  335. # Locking and shared memory parameters
  336. #
  337. # Bytes of shared memory allocated for lock manager. 
  338. # In Classic mode, the size given is used for the initial allocation. The
  339. # table expands dynamically up to the limit of memory. In SuperServer, the
  340. # initial size is also the final size.
  341. # Default is 96K on Linux and Solaris, 256K on Windows.
  342. #
  343. # Type: integer
  344. #
  345. #LockMemSize = 262144
  346.  
  347. #
  348. # Number of semaphores for interprocess communication.
  349. # In non-threading environments, this sets the number of semaphores
  350. # available
  351. #
  352. # Type: integer
  353. #
  354. #LockSemCount = 32
  355.  
  356. #
  357. # When a connection wants to lock an object, it gets a lock request 
  358. # block which specifies the object and the lock level requested. Eack
  359. # locked object has a lock block. Request blocks are connected to those
  360. # lock blocks either as requests that have been granted, or as pending
  361. # requests. 
  362. #
  363. # The settings:
  364. #     1 means locks are granted first come, first served.
  365. #    0 means emulate InterBase v3.3 behavior, where locks are granted 
  366. #      as soon as they are available; can result in lock request
  367. #       starvation.
  368. #
  369. # Type: integer/boolean
  370. #
  371. #LockGrantOrder = 1
  372.  
  373. #
  374. # In Classic, only one client process may access the lock table at any
  375. # time. Access to the lock table is governed by a mutex. The mutex can
  376. # be requested conditionally - a wait is a failure and the request must
  377. # be retried - or unconditionally - the request will wait until it is
  378. # satisfied. This parameter establishes the number of attempts that
  379. # will be made conditionally. Zero value means unconditional mode.
  380. # Relevant only on SMP machines.
  381. #
  382. # Type: integer
  383. #
  384. #LockAcquireSpins = 0
  385.  
  386. #
  387. # Tune lock hash list; more hash slots mean shorter hash chains. Only
  388. # necessary under very high load. Prime number values are recommended.
  389. #
  390. # Type: integer
  391. #
  392. #LockHashSlots = 101
  393.  
  394. # ----------------------------
  395. #
  396. # Bytes of shared memory allocated for event manager.
  397. #
  398. # Type: integer
  399. #
  400. #EventMemSize = 65536
  401.  
  402.  
  403. # ===========================
  404. # SuperServer Engine Settings
  405. # ===========================
  406. #
  407. # ----------------------------
  408. # Which CPUs should be used (Windows Only)
  409. #
  410. # In an SMP system, sets which processors can be used by the server.  
  411. # The value is taken from a bit map in which each bit represents a CPU.
  412. # Thus, to use only the first processor, the value is 1. To use both
  413. # CPU 1 and CPU 2, the value is 3. To use CPU 2 and CPU 3, the value
  414. # is 6. The default value is 1.
  415. #
  416. # Type: integer
  417. #
  418. #CpuAffinityMask = 1
  419.  
  420.  
  421. # ----------------------------
  422. # Settings for the thread scheduler (Windows Only)
  423. #
  424. # The wait time, in milli-seconds (ms), before the priority of:
  425. #    - an inactive thread is reduced to 'Low', or 
  426. #    - an active thread is increased to 'High'
  427. #
  428. # Note: The default value was chosen based on experiments on Intel 
  429. # PIII/P4 processors.  It should be increased for using in the computer
  430. # with lower speed processors.
  431. #
  432. # Type: integer
  433. #
  434. #PrioritySwitchDelay = 100
  435.  
  436. #
  437. # Number of cycles of the scheduler (PrioritySwitchDelay ms) before
  438. # thread are destroyed/closed.  Rather than immediately destroy/closed
  439. # worker threads (which would require a semaphore and blocking call --
  440. # significant overhead), the thread scheduler maintains a pool of the
  441. # threads.  When a thread has completed it's task/work, it is marked as
  442. # idle.  The idle thread is destroyed/closed after X iterations of the
  443. # scheduler loop.
  444. #
  445. # For a server with a very large number of connections (presumably more
  446. # than several hundred) the setting value should be increased. 
  447. #
  448. # The setting represents the number of loop iterations to be made before
  449. # the thread is destroyed/closed.
  450. #
  451. # Type: integer
  452. #
  453. #DeadThreadsCollection = 50
  454.  
  455. #
  456. # Number of additional 'intervals' given to a 'High' priority thread.
  457. #
  458. # Type: integer
  459. #
  460. #PriorityBoost = 5
  461.  
  462.  
  463. # ==============================
  464. # Classic Server Engine Settings
  465. # ==============================
  466. #
  467.  
  468.  
  469. # ==============================
  470. # Settings for Windows platforms
  471. # ==============================
  472. #
  473. # ----------------------------
  474. # Does the guardian restart the server every time it crashes?
  475. #    0 - only start the engine/service once
  476. #    1 - always restart the engine/service if it terminates
  477. #
  478. # Type: integer/boolean
  479. #
  480. #GuardianOption = 1
  481.  
  482.  
  483. #
  484. # ----------------------------
  485. # Priority level/class for the server process.
  486. #
  487. # The values are:
  488. #     0 (Zero) - normal priority,
  489. #     positive value - high priority (same as -B command line option)
  490. #     negative value - low priority.
  491. #
  492. # Note: All changes to this value should be carefully tested to ensure
  493. # that engine is more responsive to requests.
  494. #
  495. # Type: integer
  496. #
  497. #ProcessPriorityLevel = 0
  498.  
  499.  
  500. # ----------------------------
  501. # Local Connection Settings
  502. #
  503. # Size in bytes of one client's portion of the memory mapped file used
  504. # for local connections.
  505. #
  506. # Type: integer
  507. #
  508. #IpcMapSize= 4096
  509.  
  510. #
  511. # The name of the shared memory area used as a transport channel in local protocol.
  512. # The default value is not compatible with IB/FB1. Use value 'InterBaseIPI' to
  513. # restore compatibility, if necessary.
  514. #
  515. # Type: string
  516. #
  517. #IpcName = FirebirdIPI
  518.  
  519. #
  520. # The name of the pipe used as a transport channel in NetBEUI protocol.
  521. # Has the same meaning as a port number for TCP/IP. The default value is
  522. # compatible with IB/FB1.
  523. #
  524. # Type: string
  525. #
  526. #RemotePipeName = interbas
  527.  
  528. # 
  529. # Does the server need to create a (hidden) window used for IPC communication.
  530. # Turn this off to run the server without a window and hence without local protocol.
  531. # Can be used for running a few instances of the server simultaneously on win32.
  532. #
  533. # Type: boolean
  534. #
  535. #CreateInternalWindow = 1
  536.  
  537.  
  538. # ============================
  539. # Settings for Unix/Linux platforms
  540. # ============================
  541. #
  542. #
  543. # UNIX signal to use for interprocess communication 
  544. #
  545. # Type: integer
  546. #
  547. #LockSignal = 16
  548.  
  549.  
  550. # ----------------------------
  551. # Allow opening of data files on NFS volumes
  552. #
  553. # Allows for database files which exists on a NFS mounted partition to
  554. # be opened by the engine.
  555. #
  556. # The original behavour was to try and connect to server on the remote
  557. # machine via port 3050, this ensures that all opens of a file occur on
  558. # the same machine and locking etc can be handled appropriately. However,
  559. # this often causes frustration since often you end up in a position 
  560. # where you really do want db files to be opened by the local process
  561. # even though it resides on a NFS share.  So this option allows for this
  562. # 'feature' to be turned off.
  563. #
  564. # Type: boolean
  565. #
  566. #RemoteFileOpenAbility = 0
  567.  
  568.  
  569. #######################################
  570. #
  571. # KB to Bytes Conversion table
  572. #
  573. #######################################
  574. #
  575. #    KB     Bytes         KB     Bytes
  576. #   ----    ---------    ----    ---------
  577. #      1    1024           32    32768
  578. #      2    2048           64    65536 
  579. #      4    4096          128    131072
  580. #      8    8192          256    262144  
  581. #     16    16384         512    524288
  582. #
  583. #######################################
  584. #
  585. # MB to Bytes Conversion table
  586. #
  587. #######################################
  588. #
  589. #    MB    Bytes           MB    Bytes            MB    Bytes
  590. #   ---    ---------      ---    -----------     ---    -----------
  591. #     1    1048576         64    67108864        448    469762048
  592. #     2    2097152        128    134217728       512    536870912
  593. #     4    4194304        192    201326592       640    671088640
  594. #     8    8388608        256    268435456       768    805306368
  595. #    16    16777216       320    335544320       896    939524096
  596. #    32    33554432       384    402653184      1024    1073741824
  597. #
  598.